Interface RemoteAuthenticationCallback
public interface RemoteAuthenticationCallback
The
RemoteAuthenticationCallback interface defines the specific elements required for the
integrator to interact during the Remote Authentication flow.
This flow is initiated by the server; it is started by a call to Orchestrator.execute(String) with the command provided by the
server.
A RemoteAuthenticationCallback object should be provided to the Orchestrator
object (See Orchestrator.setRemoteAuthCallback(RemoteAuthenticationCallback))
in order to receive feedback during the remote authentication process.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceTheRemoteAuthenticationCallback.DisplayDataCallerobject is to be informed of data approval/rejection.static enumTheRemoteAuthenticationCallback.SessionOutdatedReasonlists possible reasons for a session to be outdated.static enumTheRemoteAuthenticationCallback.SuccessSessionStatelists possible session states after a Remote authentication success. -
Method Summary
Modifier and TypeMethodDescriptionvoidCalled upon remote authentication abortionvoidonRemoteAuthenticationDisplayData(String dataToDisplay, RemoteAuthenticationCallback.DisplayDataCaller caller) Called when the Orchestration SDK needs theRemoteAuthenticationCallbackobject to display data to the user for approval.voidonRemoteAuthenticationPasswordError(PasswordError passwordError) Called upon password error when performing remote authentication.voidCalled upon remote authentication session outdatedvoidonRemoteAuthenticationStepComplete(String command) Called when a step of the remote authentication process is complete.voidCalled upon remote authentication success
-
Method Details
-
onRemoteAuthenticationDisplayData
void onRemoteAuthenticationDisplayData(String dataToDisplay, RemoteAuthenticationCallback.DisplayDataCaller caller) Called when the Orchestration SDK needs theRemoteAuthenticationCallbackobject to display data to the user for approval.- Parameters:
dataToDisplay- the data to displaycaller- aRemoteAuthenticationCallback.DisplayDataCallerobject to use upon user's response
-
onRemoteAuthenticationStepComplete
Called when a step of the remote authentication process is complete. The provided orchestration command is to be sent to the server.- Parameters:
command- an orchestration command that must be sent to the server
-
onRemoteAuthenticationSuccess
Called upon remote authentication success -
onRemoteAuthenticationSessionOutdated
void onRemoteAuthenticationSessionOutdated(RemoteAuthenticationCallback.SessionOutdatedReason reason) Called upon remote authentication session outdated -
onRemoteAuthenticationAborted
void onRemoteAuthenticationAborted()Called upon remote authentication abortion -
onRemoteAuthenticationPasswordError
Called upon password error when performing remote authentication.- Parameters:
passwordError- the type of password error
-